home *** CD-ROM | disk | FTP | other *** search
/ Amiga Developer CD 2.1 / Amiga Developer CD v2.1.iso / NDK / NDK_3.5 / Documentation / Autodocs / string_gc.doc < prev    next >
Encoding:
Text File  |  1999-10-29  |  4.0 KB  |  125 lines
  1. TABLE OF CONTENTS
  2.  
  3. string_gc/--datasheet--
  4. string_gc/STRING_GetClass
  5. string_gc/--datasheet--                               string_gc/--datasheet--
  6.  
  7.    NAME
  8.         string_gc -- create string BOOPSI objects
  9.  
  10.     SUPERCLASS
  11.         gadgetclass
  12.  
  13.     REQUIRES
  14.         bevel.image
  15.  
  16.     DESCRIPTION
  17.         The string gadget class is used to create single line
  18.         editable strings. This class also supports window relativity.
  19.         This class is a subclass of rom strgclass which automatically
  20.         creates a field bevel and supports GM_DOMAIN for layout groups.
  21.  
  22.      METHODS
  23.         OM_NEW -- Passed to superclass, strgclass allocated, then OM_SET.
  24.  
  25.         OM_SET -- Passed to superclass, and strgclass is set.
  26.  
  27.         OM_UPDATE -- Passed to superclass, and strgclass is set then
  28.             rendered.
  29.  
  30.         OM_DISPOSE -- Disposes strgclass object, then passed to superclass.
  31.  
  32.         GM_RENDER -- Passed to superclass, then strgclass object
  33.  
  34.         GM_HITTEST -- Overrides supperclass, returns GMR_HITTEST.
  35.  
  36.         GM_GOACTIVE -- Passed to superclass, strgclass, string activated
  37.  
  38.         GM_HANDLEINPUT -- Routes input to strgclass object.
  39.  
  40.         GM_GOINACTIVE -- Passed to superclass, strgclass, string deactivated.
  41.  
  42.         GM_DOMAIN -- Returns GDOMAIN_MINIMUM, GDOMAIN_NOMINAL and
  43.             GDOMAIN_MAXIMUM dimensions.
  44.  
  45.      ATTRIBUTES
  46.         GA_Disabled (BOOL)
  47.             Determines whether the string is disabled or not.
  48.             Changing disable state will invoke GM_RENDER.  A disabled
  49.             string is dusted in a ghosting pattern that is rendered
  50.             in SHADOWPEN.
  51.  
  52.             Defaults to FALSE.
  53.  
  54.             Applicability is (OM_NEW, OM_SET, OM_UPDATE)
  55.  
  56.         GA_TextAttr (struct TextAttr *)
  57.             Text attribute for the font to use for the string.
  58.  
  59.             Defaults to RPort->Font, which is often the screen or
  60.             window font.
  61.  
  62.             Applicability is (OM_NEW)
  63.  
  64.         GA_ReadOnly (BOOL)
  65.             Read-only gadgets ignore activation attempts.
  66.  
  67.             Defaults to FALSE.
  68.  
  69.             Applicability is (OM_NEW, OM_SET, OM_UPDATE)
  70.  
  71.         STRINGA_MinVisible (WORD) (V41)
  72.             Set the minimum number of characters that should be
  73.             visible for a 'GDOMAIN_MIMIMUM' domain size. Nominal
  74.             domain sizes to twice this minimum. This is a handy
  75.             addition (also present in V40.35) to ensure a mimimum
  76.             number characters will be visible in a string gadget.
  77.  
  78.             Defaults to 4.
  79.  
  80.             Applicability is (OM_NEW, OM_SET, OM_UPDATE)
  81.  
  82.  
  83.      NOTES
  84.  
  85.         The string class passes all tags to its strgclass child,
  86.         please see strgclass tags & autodocs, and look in
  87.         <intuition/gadgetclass.h> for the STRINGA_ tags.
  88.  
  89.         WARNING: string.gadget is ROM strgclass wrapper, depending on
  90.         string.gadget version. Passing GA_Text can crash strgclass,
  91.         please use STRING_TextVal as its intended. STRINGA_Font and
  92.         STRINGA_LongVal are not directly supported, for numeric
  93.         strings use our more powerful integer.gadget class. To specify
  94.         the font for the gadget, use GA_TextAttr which is consistant
  95.         with all other ReAction gadget attributes.
  96. string_gc/STRING_GetClass                           string_gc/STRING_GetClass
  97.  
  98.     NAME
  99.         STRING_GetClass -- Gets the pointer to the string class.
  100.  
  101.     SYNOPSIS
  102.         string_class = STRING_GetClass();
  103.         D0
  104.  
  105.         Class * STRING_GetClass(VOID);
  106.  
  107.     FUNCTION
  108.         Obtains the pointer to the String gadget class for use with
  109.         NewObject().  This function always returns a valid pointer so
  110.         you do not need to check it.  The reason is that if the library
  111.         opens fine, then the pointer returned is already setup.  (Of course
  112.         this implies that if opening the library fails, you shouldn't be
  113.         calling this.)
  114.  
  115.         Note that this function does not create the class, that is done
  116.         when the class library is opened.
  117.  
  118.     INPUTS
  119.         Nothing.
  120.  
  121.     RESULT
  122.         string_class - Pointer to the String gadget class.
  123.  
  124.     SEE ALSO
  125.